/*
 * Copyright (c) 2010, okazoh_tk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALKES_FILE_STREAM_H_INCLUDED_
#define ALKES_FILE_STREAM_H_INCLUDED_

#include "alkes/core/Stream.h"

namespace alkes {

/// \addtogroup io
//@{

enum AccessMode
{
    AL_ACCESS_READ      = 0x0001,
    AL_ACCESS_WRITE     = 0x0002,
    AL_ACCESS_READWRITE = AL_ACCESS_READ|AL_ACCESS_WRITE,
};

enum OpenMode
{
    AL_OPEN_EXISTING = 0x0000,  ///< Open the existing file. If the file does not exist, the operation will fail.
    AL_OPEN_CREATE,             ///< Open the file. If the file does not exists, it will be created.
    AL_OPEN_TRUNCATE,           ///< Open the file. If the file already exists, it will be truncated to 0.
};

class AL_EXPORT FileStream
    : public Stream
{
public:
    FileStream(const char* filepath, AccessMode accessmode, OpenMode openmode);
    FileStream(const wchar_t* filepath, AccessMode accessmode, OpenMode openmode);
    virtual ~FileStream();

protected:

    virtual int64_t onGetLength();
    virtual int64_t onGetPosition();

    virtual int32_t onRead(int32_t count, void* buffer, int32_t offset);
    virtual int32_t onWrite(int32_t count, const void* buffer, int32_t offset);
    virtual int64_t onSeek(int64_t offset, SeekOrigin origin);

    virtual void onFlush();
    virtual void onClose();

private:
    void openFile(const char* filepath, AccessMode accessmode, OpenMode openmode);
    void closeFile();

private:
    void* fp_;
};

//@}

}

#endif
